home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / seabat31.zip / SEABATLE.DOC < prev    next >
Text File  |  1992-04-02  |  10KB  |  225 lines
  1.  
  2.  
  3.                                   SEABATLE
  4.  
  5.                             a DOORware program by
  6.                                 Roland Haley
  7.                              Copyright (C) 1992
  8.                                     using
  9.  
  10.                                 DOORPCH v3.8
  11.  
  12.                                      by
  13.                                Raymond Clements
  14.                             Copyright (C)1987-1991
  15.  
  16.  
  17.  
  18.  
  19.  
  20.                                    Preface
  21.                                   ---------
  22.  
  23.          This is NOT meant to tell you how to setup DOORs on your BBS,
  24.          just how to setup DORPCH38 doors.
  25.  
  26.  
  27.                                 Support Shareware
  28.                                -------------------
  29.  
  30.          Thank you for obtaining this door program.  Many hours of coding
  31.          have gone into its development.  Like all shareware products,
  32.          You're encouraged to register this program if it meets your needs.
  33.          Supporting Shareware helps insure the future development of such
  34.          programs and will entitle you to support from their authors.
  35.  
  36.  
  37.                               Environment variables
  38.                              -----------------------
  39.  
  40.          Two environment variables must be set in your AUTOEXEC.BAT file:
  41.  
  42.          SET LIB=<drive:><path to DORPCH38.EXE>  Note: ONLY the PATH!
  43.  
  44.          Example:  SET LIB=C:\MYLIB
  45.  
  46.          The DORPCH38.EXE run-time library and DOORPCH.CFG files must then
  47.          be placed in this directory.  I'd suggest a separate directory as
  48.          I do on my system and include it in your PATH statement.
  49.  
  50.  
  51.          SET DOORPCH=PCB     This variable is required by prior versions
  52.                              of DOORPCH, but not by DORPCH38.EXE.
  53.  
  54.          For your convenience DOORPCH v3.8 also supports the following three
  55.          new variables:
  56.                         %NODE% , %DRIVE% , and %DIRECTORY%
  57.  
  58.                         SET NODE=1          (ie. 1 , 2 , etc.)
  59.                         SET DRIVE=C:        (ie. C: , D: , etc.)
  60.                         SET DIRECTORY=\BBS\ (ie. \PCB\ , \BBS\ , etc.)
  61.  
  62.          These may be used to allow a single SEABATLE.CFG file for all nodes.
  63.          When using these variables please remember the combination of them
  64.          MUST form a valid DOS 'drive:\path\' pointing to the location of the
  65.          BBS interface file.
  66.  
  67.  
  68.                                    DOORPCH.KEY
  69.                                   -------------
  70.  
  71.          DoorPch is released as a completely UNcrippled program.  Upon
  72.          registering DoorPch you'll receive a DOORPCH.KEY file.  This
  73.          file should be put in the 'SET LIB = ' directory along with the
  74.          DORPCH38.EXE and DOORPCH.CFG files.  Upon exiting, all DOORs
  75.          using DoorPch v3.8 will then say 'This copy of DoorPch v3.8 is
  76.          registered to: ' and your BBS name, your name and your serial
  77.          number.
  78.  
  79.  
  80.                                     DOOR Setup
  81.                                    ------------
  82.  
  83.          Make a batch file to run the DOOR as described in your BBS
  84.          documentation.
  85.  
  86.  
  87.  
  88.          @ECHO OFF
  89.          You may use the environmental variables to only require one
  90.          SEABATLE.CFG file for multiple nodes.
  91.  
  92.          C:\BBS\DOOR.SYS             <== The drive:\path\filename
  93.                                          of your BBS interface file
  94.                                          which is the same as
  95.  
  96.                                          %DRIVE%%DIRECTORY%DOOR.SYS
  97.  
  98.                                          using the above variables.
  99.          Haley's Comment BBS         <== The name of your BBS.
  100.          Roland                      <== The SysOp's FIRST name.
  101.          Haley                       <== The SysOp's LAST name.
  102.          Your SysOp                  <== The name of the DOOR's donor.
  103.          20                          <== Maximum number of games allowed.
  104.          D:\NEWS\0NEWS.TXT           <== The drive:\path\filename for bulletin.
  105.  
  106.  
  107.  
  108.                             Command-line parameters
  109.                            -------------------------
  110.  
  111.          This parameter may be used when starting a DOORPCH v3.8 DOOR.
  112.  
  113.          /LOCAL                      <== Allows local usage of the DOOR as
  114.                                          the SysOp.
  115.                                          (ie. SEABATLE SEABATLE.CFG /LOCAL)
  116.  
  117.  
  118.                                    LIBRARIES
  119.                                   -----------
  120.  
  121.          All DOORPCH v3.8 DOORs require the DORPCH38.EXE run-time library
  122.          and the Microsoft (R) QuickBASIC 3.0 run-time library, BRUN30.EXE,
  123.          be in your path.  Your DOOR program may have come with these files
  124.          in the archive file.  If they are not present, this DOOR program
  125.          WILL NOT RUN.  You should contact the DOOR author if the files
  126.          are missing.  You require one and only one version of these two
  127.          libraries for ALL DOORPCH v3.8 DOORware.
  128.  
  129.  
  130.  
  131.                                   DOOR operation
  132.                                  ----------------
  133.  
  134.          When this DOOR is in operation you have complete control over the
  135.          caller.  This DOOR was written using DOORPCH v3.8.  The logic is
  136.          safe and every precaution has been taken to insure this code works
  137.          flawlessly.  If it doesn't, please let us know.  Many
  138.          function/operational keys are at your disposal:
  139.  
  140.          F1    -   Displays the version of DOORPCH compiled and linked
  141.                    into the DOOR.
  142.          F2    -   Displays a caller's Alias if one is used via the DOOR.
  143.          F3    -   Toggles Local Music ON/OFF.
  144.          F4    -   Toggles the Bell ON/OFF.
  145.                    Value is returned to BBS when DOOR completes.
  146.          F5    -   DOS Shell.  Allows the SysOp to exit to DOS from inside
  147.                    a DOOR.
  148.          F6    -   Toggles the Graphics mode of the caller ON/OFF.
  149.                    Value is returned to BBS when DOOR completes.
  150.          F7    -   Toggle the caller alarm ON/OFF.
  151.                    Value is returned to BBS when DOOR completes.
  152.          F8    -   Involuntarily returns the caller to the BBS.
  153.          F9    -   Toggles the display ON/OFF.
  154.                    Value is returned to BBS when DOOR completes.  Some doors
  155.                    may force the display ON, but the original OFF value will
  156.                    be returned to the BBS if this occurs.
  157.          F10   -   Activates SysOp/Caller CHAT mode within the DOOR.
  158.          ESC   -   Deactivates CHAT mode.  DOOR is resumed.
  159.          ALT-H -   HELP key for lines 24/25 capabilities.
  160.          UP    -   Allows the SysOp to add additional time for the caller.
  161.                    Value is returned to BBS when DOOR completes.
  162.          DN    -   Allows the SysOp to subtract time from the caller.
  163.                    Value is returned to BBS when DOOR completes.
  164.          ALT-N -   Some BBSs use SysOp next on control/indicator.
  165.                    Value is returned to BBS when DOOR completes.
  166.          ALT-X -   Some BBSs will exit after current caller completes their
  167.                    session.  Value is returned to BBS when DOOR completes.
  168.  
  169.  
  170.                             Example: device = ANSI.SYS
  171.                             --------------------------
  172.  
  173.          DOORPCH uses this device driver for displaying all colors and
  174.          screen positioning to the local console.  ANSI Color Graphics will
  175.          always be sent to the local console if you are using a color
  176.          monitor.  If a caller is in non-graphics mode you will still see
  177.          colors if you have a color monitor.  The reverse is also true.
  178.          If the caller is in graphics mode and the local console is a mono
  179.          monitor then colors will NOT be displayed to the local console.
  180.  
  181.  
  182.                                        BELL
  183.                                       ------
  184.  
  185.          DOORPCH logic will not allow a BELL to be sent to the local
  186.          console when the local screen is inactive (F9 OFF) or the caller
  187.          alarm is toggled off (F7 OFF).  This, of course, assumes the
  188.          DOOR author follows the DOORPCH rules.
  189.  
  190.  
  191.                                       Errors
  192.                                      --------
  193.  
  194.          All errors should recover and cause the DOOR program to exit
  195.          gracefully and return to the main system.  All errors are logged
  196.          in the 'DOORPCH.ERR' file found in the 'SET; LIB =' directory.  The
  197.          error number and line number are included with the date and time.
  198.          Errors will be either caused by the main module (the authors code,
  199.          contact him/her) or the DOORPCH sub (contact Raymond Clements).
  200.          It should NEVER cause the BBS to hang.  If your BBS hangs, you are
  201.          requested to contact the appropriate party and report the error and
  202.          circumstances that caused it.  Because we are using Microsoft's (c)
  203.          QuickBASIC 3.0 run-time routines, it is possible that BASIC will
  204.          detect a fatal error condition.  As mentioned above, we have taken
  205.          every precaution, but simply cannot code for every error condition.
  206.          If the DOOR author follows all the rules, the DOOR should run without
  207.          error.
  208.  
  209.  
  210.                                     REGISTRATION
  211.                                     ------------
  212.  
  213.          To register this door, please read and fill out the ORDER.FRM which
  214.          is included in this ZIP.
  215.  
  216.  
  217.                                   HALEY'S  COMMENT  BBS
  218.                                  -----------------------
  219.                                     PCBoard v14.5a/E3
  220.  
  221.                                      (519) 469-3028
  222.                                      (519) 469-3173
  223.                                      (519) 539-6851
  224.  
  225.